Discovery API - Test icon

Discovery API - Test

1.0.x
(0 reviews)

Example - Discovery using address

Prepare your address in ezi-address format (see specification for more information on this format), example: '328/800 SWANSTON STREET CARLTON 3053'

The GET /discovery/v1/properties accepts a query parameter 'eziAddress' (note that query parameters must be URL Encoded - most HTTP libraries will handle this automatically).

Example request
curl --request GET \
  --location 'https://test.api.servictoria.io/ddp/discovery/v1/properties?eziAddress=328%2F800%20SWANSTON%20STREET%20CARLTON%203053' \
  --header 'Authorization: Bearer ******'
Example response

The response will include a property summary for each matched property. Each property summary will include all the titles and land parcels related to the property.

In this case there is only a single property matching our input address, and it only has a single related title.

Titles are typically uniquely identified by a volume/folio (eg '10940/843') however since a fee is charged to lookup volume/folios this API instead returns an encrypted titleId without incurring a cost.

{
    "propertySummaries": [
        {
            "propertyPfi": "208045633",
            "propertyStatus": "ACTIVE",
            "isCouncilPropertyRegistered": true,
            "councilPropertyDetails": {
                "propertyNumber": "603787",
                "municipalityName": "MELBOURNE"
            },
            "isMultiAssess": false,
            "propertyCreatedDate": "2006-08-29 14:57:32",
            "primaryAddress": {
                "eziAddress": "328/800 SWANSTON STREET CARLTON 3053",
                "addressDetails": {
                    "unitType": "UNIT",
                    "unitNumber": "328",
                    "levelType": "L",
                    "levelNumber": "3",
                    "streetNumber": "800",
                    "streetName": "SWANSTON",
                    "streetType": "STREET",
                    "suburbTownLocality": "CARLTON",
                    "postcode": "3053"
                }
            },
            "aliasAddresses": [],
            "landParcels": [
                {
                    "spi": "3A2\\PS515587",
                    "parcelType": "LOT",
                    "parcelStatus": "ACTIVE"
                }
            ],
            "titles": [
                {
                    "titleId": "qp0gjuieZ5VzbNKtT/eZvqPryobRkEYxMA==",
                    "titleStatus": "ACTIVE",
                    "titleType": "FREEHOLD"
                }
            ]
        }
    ]
}

Reviews